home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / edit / aaem95ma.zip / HELP.BIG < prev    next >
INI File  |  1995-02-27  |  17KB  |  374 lines

  1. [NOTES ABOUT ABBREVIATIONS ETC IN LONG HELP]
  2. N = numeric argument of call. If unset, treated as 1 unless stated otherwise.
  3. D = 1 if N is set, else 0.
  4. T1 = first  text argument (if any) that the subroutine or key asks for.
  5. T2 = second text argument (if any) that the subroutine or key asks for.
  6. K = key sequence argument (if any) that the subroutine or key asks for.
  7. marks are numbered 1 2 etseq from the top of the mark stack,
  8.   and also -1 -2 etseq from the bottom of the mark stack. Mark 0 means mark 1.
  9. Mark 999 = where the cursor was before the last command call, so, after acciden-
  10.   tally pressing `end', `esc 999 ctrlX ctrlX' goes back where you were before.
  11. If an empty string is typed for a buffer name, the buffer menu is entered.
  12. If a directory name is typed for a buffer name, the directory displays as a menu
  13. If '=' is typed for a buffer name, it means 'current buffer'.
  14. The kill ring has 16 positions.
  15. End-of-line is treated as a character.
  16. End of sentence is '.' or '!' or '?' with eol or space or tab after.
  17. End of paragraph is blank line or line starting with space or tab.
  18. e.g. {capitalize, 'altC'}: capitalize is subr name, altC is keysequence.
  19. '$' = 'not from macro' = "fault-remark or does nothing when called from macro".
  20. --------------------------------------------------------------------------------
  21. {accentedletters}
  22.   If N==0, stop  treating the PC accented letters as alphanumeric chars.
  23.   If N!=0, start treating the PC accented letters as alphanumeric chars.
  24. {backspace, 'ctrlH', 'backspace'}
  25.   Delete N chars before cursor. If N<0, do nothing.
  26. {beginmacro, 'ctrlX ('}
  27.   Start recording new current macro. Not from macro.
  28. {bindkeybuf, 'esc altK'}
  29.   Bind buffer named T1 to key K.
  30. {bindkeymacro, 'esc K'}
  31.   Bind current macro to key K.
  32. {bindkeysubr}
  33.   Bind subroutine named T1 to key K.
  34. {buffer}
  35.   If N<0, as 'splitwindow -N'; if N>0, as 'openfile'; if N=0, as 'insertfile'.
  36. {buffermenu, 'ctrlX ctrlB'}
  37.   Choose buffer by menu. Show that buffer in this window. Not from macro.
  38. {calldos, 'ctrlX ctrlE'}
  39.   Call DOS command. Afterwards, press any key to get buffer display back.
  40. {callsubr, 'altX'}
  41.   Obey subroutine or macro named T1. Null string gets menu of subroutine names.
  42. {capitalize, 'altC'}
  43.   Change N words starting with this word to 'first letters uppercase, rest
  44.   lowercase'. If N<0, operate on -N words finishing with this word.
  45. {casemode}
  46.   Set buffer mode: If N>=1 recognise, else ignore, case when searching for text.
  47. {cbrackets, 'ctrl2'}
  48.   Check from mark N to cursor for C language bracket matching. Looks for ()[]{}"
  49.   and /* */. Won't work properly if the region starts inside a C string.
  50. {cccmode}
  51.   If N>=1 set, else cancel, mode to counterchange at cursor, as laptop cursors
  52.   are sometimes hard to see.
  53. {cchrstr, 'ctrlX D'}
  54.   Convert \sequence as in C string at pointer to literal char.
  55. {checkhelp}
  56.   Report any bound keys not listed in file HELP.
  57. {checkspelling, 'altI'}
  58.   Check spelling of next word. If N set and not 0, check spelling of all words
  59.   in region. If N is set, puts unlisted words in the dictionary's appendix. The
  60.   first time checkspelling is called, wait while AAEMACS reads its dictionary;
  61.   you can tell it to read its dictionary from another file than the default.
  62. {copydir}
  63.   Put a copy of directory T1 (as arg of MSDOS command DIR) into the kill ring.
  64. {copykill, 'altW'}
  65.   Copy from mark N to cursor onto kill ring.
  66. {copytext, 'esc C'}
  67.   Copy to cursor text from mark N to mark (N+1).
  68. {cstrchr, 'ctrlX ctrlD'}
  69.   Convert control char or " or \ at pointer to \n or \xxx as in C string.
  70. {delblanklines, 'ctrlX ctrlO'}
  71.   Delete blank lines around cursor.
  72. {delbuf}
  73.   Remove current buffer from ring of buffers.
  74. {delete, 'ctrlD', 'deletekey'}
  75.   Delete N chars starting at the cursor. If N<0, insert -N spaces.
  76. {deletewhite, 'esc \'}
  77.   Delete all spaces and tabs round cursor.
  78. {display}
  79.   Display T1 on the mode line in cyan.
  80. {displayhex, 'esc X'}
  81.   Display from cursor as hexadecimal.
  82. {emptyappendix}
  83.   Empty the spelling checker's dictionary's appendix.
  84. {endmacro, 'ctrlX )'}
  85.   Stop recording new current macro. Not from macro.
  86. {expandtabs, 'ctrlX ctrlT'}
  87.   Expand all tabs to spaces in region.
  88. {finalcr, 'altJ'}
  89.   Add an assumed CR before the assumed LF at all end-of-lines in region.
  90. {findb, 'ctrlR'}
  91.   Search backwards for T1. If N set, stop at mark N.
  92. {findf, 'ctrlS'}
  93.   Search forwards for T1. If N set, stop at mark N.
  94. {findwordb, 'esc ctrlR'}
  95.   Search backwards for T1 as whole word. If N set, stop at mark N.
  96. {findwordf, 'esc ctrlS'}
  97.   Search forwards for T1 as whole word. If N set, stop at mark N.
  98. {finish, 'ctrlX ctrlZ'}
  99.   Exit from emacs.
  100. {formatpara, 'altQ'}
  101.   Reformat this paragraph to uniform line length.
  102. {formatinsetregion, 'esc X esc Q'}
  103.   Reformat between mark N and cursor to uniform line length, allowing old and
  104.   new left margin characters.
  105. {formatregion, 'esc Q'}
  106.   Reformat between mark N and cursor to uniform line length.
  107. {getappendix}
  108.   Copy all new words in region into spelling checker's dictionary's appendix.
  109. {godown, 'ctrlN', 'downarrow'}
  110.   Go down N lines (-N up).
  111. {godownpart, 'ctrldownarrow'}
  112.   In fold-long-lines mode, go about N line-folds downwards (-N up).
  113. {goleft, 'ctrlB', 'leftarrow'}
  114.   Go left N chars. If N<0, go right -N chars.
  115. {goright, 'ctrlF', 'rightarrow'}
  116.   Go right N chars. If N<0, go left -N chars.
  117. {goto}
  118.   Jump to a label. See file MACROS.HLP . Only use in macros, not after alt-X
  119. {gotobof, 'home'}
  120.   Go to start of buffer.
  121. {gotobol, 'ctrlA'}
  122.   Go to start of line.
  123. {gotocol, 'esc G'}
  124.   Go to Nth char in line (leftmost char is 1st, not 0th).
  125. {gotodir, 'altO'}
  126.   Go to file selected by menu of current buffer's file's directory.
  127. {gotoeof, 'end'}
  128.   Go to last line of buffer.
  129. {gotoeol, 'ctrlE'}
  130.   Go to end of line.
  131. {gotoline, 'altG'}
  132.   Go to Nth line of buffer (top line of buffer is 1st, not 0th).
  133. {gotonbuf, 'ctrlX X'}
  134.   Go to next buffer in circle of buffers.
  135. {goup, 'ctrlP', 'uparrow'}
  136.   Go up N lines. If N<0, go down -N lines.
  137. {gouppart, 'ctrluparrow'}
  138.   In fold-long-lines mode, go about N line-folds up (-N down).
  139. {help, 'ctrl_'}
  140.   Say what key K does. If K = one of 'a i L l r s', other information
  141.   (type 'ctrl_ ?' for more information).
  142. {if}
  143.   If N!=0, obey T1, else obey T2. Only use in macros, not after alt-X
  144.   See file MACROS.HLP
  145. {incrfindb, 'ctrlX R'}
  146.   Incremental search backwards for T1. If N set, stop at mark N.
  147. {incrfindf, 'ctrlX S'}
  148.   Incremental search forwards for T1. If N set, stop at mark N.
  149. {insert}
  150.   Insert T1 into the buffer just before the pointer, N times.
  151. {insertfile, 'ctrlX tab', 'ctrlX ctrlI'}
  152.   Insert text of file T1 at cursor.
  153. {insertspaces, 'insertkey'}
  154.   Insert N spaces. If N<0, delete -N chars starting at cursor.
  155. {kill_to_eol, 'ctrlK'}
  156.   (if at EOL, kill the EOL, else kill to EOL) N times (-N times left if N<0)
  157.   Put the killed text on the kill ring.
  158. {killregion, 'ctrlW'}
  159.   Remove text from mark N to cursor, and put it on the kill ring.
  160. {killsent, 'altK'}
  161.   Search forwards (-N times backwards if N<0) N times for end of sentence.
  162.   Remove text from there to cursor, and put it on the kill ring.
  163. {killwordb, 'altbksp', 'altH'}
  164.   Search backwards (-N times forwards if N<0) N times for end of word.
  165.   Remove text from there to cursor, and put it on the kill ring.
  166. {killwordf, 'altD', 'altdelete'}
  167.   Search forwards (-N times backwards if N<0) N times for end of word.
  168.   Remove text from there to cursor, and put it on the kill ring.
  169. {leaveonewhite, 'esc /'}
  170.   Delete all spaces and tabs round cursor, then insert a space there.
  171. {linefeed}
  172.   Insert N linefeeds, all with their 'no CR before LF here' bits set.
  173. {literalchar, 'ctrlQ'}
  174.   Put next char into buffer even if it is control char. Not from macro.
  175.   'ctrlQ alt0' puts ASCII-zero char into buffer.
  176.   'ctrlQ ctrltab' selects char by menu ('end' key exits menu without inserting).
  177.   'ctrlQ ctrlM' or 'ctrlQ ret' inserts ctrlM (CR) by itself.
  178. {longlinesmode}
  179.   Set buffer mode: if N=0, slide display left-right if necessary to get cursor
  180.   on screen. If N=1, fold long lines on screen.
  181. {lwcaseregion, 'ctrlX ctrlL'}
  182.   Change all uppercase letters to lowercase between mark N and cursor.
  183. {lwcasewords, 'altL'}
  184.   Change all uppercase letters to lowercase in this and N-1 following words.
  185.   (If N<0, this and (-N)-1 preceding words).
  186. {macromenu, 'altsharp'}
  187.   Menu of currently defined macros.
  188. {maketabs, 'ctrlX ctrlY'}
  189.   Convert spaces to tabs in region.
  190. {markbof, 'althome'}
  191.   Set mark N at start of buffer.
  192. {markeof, 'altend'}
  193.   Set mark N at end of buffer.
  194. {menu, 'altequals', 'rightbutton', 'middlebutton'}
  195.   Menu of AAEMACS commands. Arrows move pointer. RET calls selected subroutine.
  196.   END backs out of menu or submenu. ctrl_ gets help for selected subroutine.
  197.   After RET, asks you for numeric argument `N' of the call: + and - change sign,
  198.   backspace removes last digit, END backs out of subroutine call, PAGEDOWN
  199.   enters arg (if no digits, call has no arg) and calls the subroutine.
  200. {mergefile}
  201.   Merge file T1 into region in ascii order. Both should be in ascii order
  202.   before. If in ignore-case-on-search mode, treat A-Z as a-z when merging.
  203. {modemenu, 'altM'}
  204.   Set this buffer's modes by menu. Not from macro.
  205. {mouse_mode, 'leftbutton'}
  206.   Mouse operations. They are not recorded individually by "record a macro".
  207.     Moving the mouse about moves the cursor.
  208.     `esc', or clicking the left button, exits to ordinary mode.
  209.     Dragging the left button sets the mousing region (mark 1 to mark 2).
  210.     `del' deletes that region.
  211.     `M' moves that region to where the cursor is.
  212.     `C' copies that region to where the cursor is.
  213. {mouse_move, 'mousemove'}
  214.   Move the cursor.
  215. {movetext, 'esc M'}
  216.   Move to cursor text from mark N to mark (N+1).
  217. {namemacro, 'esc ctrlN'}
  218.   Give macro bound to K the name T1. Remove name if T1 is empty string. Else T1
  219.   must be alphanumeric. Current macro if K is bound to subroutine 'obey'.
  220. {newline, 'ctrlJ', 'ret'}
  221.   Insert eol into buffer, i.e. split this line here.
  222. {nextwindow, 'esc N'}
  223.   Go to next window in circle of windows.
  224. {nofinalcr, 'esc J'}
  225.   Remove an assumed CR before the assumed LF at all end-of-lines in region.
  226. {nomove}
  227.   Write the last character of T1 into the buffer. Overwrite the character that
  228.   was there before, unless the pointer is at end of line. Do not move pointer.
  229. {obey, 'ctrlX E'}
  230.   Obey current macro N times. If N<=0, do nothing.
  231. {onewindow, 'ctrlX 1'}
  232.   Remove all windows except this window.
  233. {openfile, 'ctrlX ctrlF'}
  234.   Go to buffer open on file named T1. If necessary, create and read new buffer.
  235. {openline, 'altinsert', 'ctrlO'}
  236.   Same as 'newline' then 'backspace'.
  237. {overlay}
  238.   Write T1 into the buffer N times, overwriting until end of line, then
  239.   inserting. Leave the pointer after the last character written.
  240. {overlaymode}
  241.   Set buffer mode for what typed chars do: N=0 inserted; N=1 overlay and cursor
  242.   moves; N=2 overlay and cursor stays still.
  243. {page_down, 'ctrlV', 'pagedown'}
  244.   Go down (window height - 2) lines, N times. (Up if N<0).
  245. {page_up, 'altV', 'pageup'}
  246.   Go up (window height - 2) lines, N times. (Down if N<0).
  247. {popmark, 'esc ,'}
  248.   Move cursor to mark on top of mark stack. Remove that mark from mark stack.
  249. {prbindings}
  250.   In current buffer list current key bindings.
  251. {prbuffers}
  252.   In current buffer list buffers with bindings, in form obeyable by readmacros.
  253. {prevwindow, 'esc P'}
  254.   Go to previous window in ring of windows.
  255. {prkeynames}
  256.   In current buffer list names of all alt keys and special keys.
  257. {prkeys}
  258.   In current buffer list all current key bindings.
  259. {prmacros}
  260.   In current buffer list all macros, in form obeyable by readmacros.
  261. {prmacro}
  262.   In current buffer list current macro, in form obeyable by readmacros.
  263. {prsubrnames}
  264.   In current buffer list all subroutine names.
  265. {pushmark, 'esc .'}
  266.   Add a mark to top of mark stack, set it at current cursor.
  267. {putappendix}
  268.   Copy the spelling checker's dictionary's appendix into the current buffer.
  269.   Unless N<1, only list words that have been listed as "vocabulary".
  270.   If N<0, put '/#1' after vocabulary words and '/#0' after other words.
  271. {readmacros}
  272.   Read buffer T1 (read file if no such buffer). Translate it into macros and
  273.   buffer bindings. Read the buffers. Obey the macro bindings & buffer bindings.
  274. {refresh_display, 'ctrlL'}
  275.   Move display so this line becomes Nth line in window.
  276.   If N not defined, N = middle line of screen and refresh screen.
  277. {remmark, 'esc #'}
  278.   Take N marks off top of stack. Do not move cursor.
  279. {renamebuffer, 'ctrlX N'}
  280.   Rename this buffer as filename T1.
  281. {repeat, 'ctrlZ'}
  282.   Obey last instruction (not 'repeat's) N times.
  283. {repl, 'altR'}
  284.   From cursor to mark N, replace all T1 by T2.
  285. {replask, 'altS'}
  286.   From cursor to mark N, replace all T1 by T2, asking each time.
  287. {replword, 'esc altR'}
  288.   From cursor to mark N, replace all T1 by T2, whole word only.
  289. {replwordask, 'esc altS'}
  290.   From cursor to mark N, replace all T1 by T2, whole word only, asking each time
  291. {replyank, 'altY'}
  292.   If previous command was yank or replyank, replace yanked text by text N steps
  293.   back (N<0 = forwards) in kill ring; else as 'yank with N not defined'.
  294. {restorebuf, 'esc ctrlF'}
  295.   Re-read this buffer from its file.
  296. {savebuffer, 'ctrlX ctrlS'}
  297.   Write this buffer to its file.
  298. {setmark, 'esc space'}
  299.   Set mark N to cursor.
  300.   If N-1 marks in stack, pushes a new mark onto the <bottom> of the stack.
  301. {setolddot, 'leftbuttondown'}
  302.   Set that buffer's 'old dot' to set the start of the mousing region.
  303. {setrightmargin, 'ctrlX F'}
  304.   If N not set, find right margin setting. Else, set right margin setting to N
  305.   (N<10 means 71). N<0 means "-N 'n'-widths proportionate for Epson printer".
  306. {setsortcol}
  307.   If N not set, find how many characters at the start of each line for sortlines
  308.   to ignore, else set it = N.
  309. {showinfo, 'ctrlX ='}
  310.   Display various info re current cursor and the char at cursor.
  311. {showregion, 'altZ'}
  312.   From cursor to mark N, magenta background at next screen display.
  313.   If N=0, show from mark 1 to mark 2 (see 'copytext' & 'movetext').
  314. {skipafterwordmode}
  315.   Set buffer mode: If N=i+j:-
  316.   When counting words forwards, do/don't(as i=0/1)skip nonword chars after word.
  317.   When counting words backwards,do/don't(as j=0/2)skip nonword chars after word.
  318. {skipparab, 'altP'}
  319.   Search backwards N times for end-of-paragraph (-N times forwards if N<0).
  320. {skipparaf, 'altF'}
  321.   Search forwards N times for end-of-paragraph (-N times backwards if N<0).
  322. {skipsentb, 'altA', 'altuparrow'}
  323.   Search backwards N times for end-of-sentence (-N times forwards if N<0).
  324. {skipsentf, 'altE', 'altdownarrow'}
  325.   Search forwards N times for end-of-sentence (-N times backwards if N<0).
  326. {skipwordb, 'altB', 'altleftarrow'}
  327.   Search backwards N times for end-of-word (-N times forwards if N<0).
  328. {skipwordf, 'altF', 'altrightarrow'}
  329.   Search forwards N times for end-of-word (backwards if N<0).
  330. {sortlines}
  331.   Sort lines that end in region, into ascii order. If in ignore-case-on-search
  332.   mode, treat uppercase A-Z as lowercase when sorting.
  333. {splitwindow, 'ctrlX 2'}
  334.   Split this window into 2 windows. Upper window keeps N lines (half the lines
  335.   if N not set), and shows same buffer. Lower window shows buffer T1.
  336. {swopmark, 'ctrlX ctrlX'}
  337.   Set cursor and mark N to each other's values.
  338. {tabmode}
  339.   Set buffer mode: N=0 show tab as one char; N=1 obey tab as tabulate to next
  340.   tab position (set every 8 chars in line); N=2 do both.
  341. {tabulate, 'tab'}
  342.   Put a tab char into buffer.
  343. {times4, 'ctrlU'}
  344.   Set N to N*4. Not from macro.
  345. {twiddle, 'ctrlT'}
  346.   Move this character N chars forwards (N<0 = backwards), but not past eol.
  347. {twiddlelines, 'esc T'}
  348.   Move this line N lines down (N<0 = upwards).
  349. {twiddlewords, 'altT'}
  350.   Move this word N words forwards (N<0 = backwards).
  351. {twodmode}
  352.   Set buffer mode: start/stop as N=1/0, appending spaces when cursor goes off
  353.   end of line, rather than going onto next line.
  354. {unbindkey, 'esc ctrlK'}
  355.   Unbind key K.
  356. {upcaseregion, 'ctrlX ctrlU'}
  357.   Change to uppercase all letters between mark N and cursor.
  358. {upcaseword, 'altU'}
  359.   Change to uppercase all letters in this and N-1 following words.
  360.   (if N<0, this and (-N)-1 preceding words).
  361. {version}
  362.   Display the version date of the version of AAEMACS that you are using.
  363. {whoa, 'ctrlG'}
  364.   Complain about illegal keypunch.
  365. {wrapmode}
  366.   Set buffer mode: stop/start (as N=0/1) inserting newline before last word(s)
  367.   in this line if you type a char on or to right of the current right margin.
  368. {writebuffer, 'ctrlX ctrlW'}
  369.   Copy this buffer to new buffer named T1. (Fault if buffer already exists.)
  370.   If N!=0, write that new buffer to its file.
  371. {yank, 'ctrlY'}
  372.   Insert at cursor a copy of current member of kill ring. Leave cursor at end of
  373.   insertion. If N set, leave mark N at start of insertion.
  374.